<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>VCR xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/mbari/vcr/rs422/VCR.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * @(#)VCR.java   2009.02.24 at 09:44:56 PST</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Copyright 2007 MBARI</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * <a href="http://www.gnu.org/copyleft/lesser.html" target="alexandria_uri">http://www.gnu.org/copyleft/lesser.html</a></em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">package</strong> org.mbari.vcr.rs422;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> gnu.io.CommPortIdentifier;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> gnu.io.NoSuchPortException;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> gnu.io.PortInUseException;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> gnu.io.SerialPort;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> gnu.io.UnsupportedCommOperationException;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> java.io.OutputStream;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.mbari.comm.BadPortException;
<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.mbari.comm.CommUtil;
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.mbari.movie.Timecode;
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.mbari.util.NumberUtilities;
<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.IVCR;
<a name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.IVCRReply;
<a name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.VCRAdapter;
<a name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.VCRException;
<a name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.VCRUtil;
<a name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">/**</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;Control software for Sony VCR's. This class connects to the VCR using the</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * RS-422 (Sony 9-pin) protocol through a serial port (RS-232). Note that the</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * pin setting of RS-232 and RS-422 are &lt;u&gt;NOT&lt;/u&gt; the same. Connecting to the</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * VCR will require a pin converter.&lt;/p&gt;</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> *</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;When a command is sent to the VCR this class will get the VCR's reply and</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * update the various status objects(VCRReply, VCRTimecode, VCRError, and VCRState)</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * as needed. Access to the status objects can be obtained by using an IVCRManager</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * object. Get the IVCRManager object by calling VCR.getVcrManager();&lt;/p&gt;</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> *</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;&lt;font color="ff3333"&gt;Requires the java COMM package.&lt;/font&gt;&lt;/p&gt;&lt;/p&gt;</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> *</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * @author : $Author: hohonuuli $</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * @version : $Revision: 332 $</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> */</em>
<a name="61" href="#61">61</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/mbari/vcr/rs422/VCR.html">VCR</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/mbari/vcr/VCRAdapter.html">VCRAdapter</a> {
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>      <em class="jxr_javadoccomment">/**</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     * For RXTX we have to put the thread to sleep VERY briefly</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * in order for the serial io to work</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     */</em>
<a name="67" href="#67">67</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> IO_DELAY = 10;
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em class="jxr_javadoccomment">/**</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     * Maximum receive timeout in millisecs</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     */</em>
<a name="72" href="#72">72</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">long</strong> RECEIVE_TIMEOUT = 40;
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Record command */</em>
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(VCR.<strong class="jxr_keyword">class</strong>);
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <em class="jxr_javadoccomment">/**</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     *     @uml.property  name="maxRetrys"</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     */</em>
<a name="81" href="#81">81</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxRetrys = 5;    <em class="jxr_comment">// No of attempts to try connecting</em>
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em class="jxr_comment">//private byte[] resumeCommand;         // Not implemented yet. To be used for pause.</em>
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em class="jxr_javadoccomment">/**</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     *     @uml.property  name="retryConnection"</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     */</em>
<a name="88" href="#88">88</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> retryConnection = <strong class="jxr_keyword">true</strong>;
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>      <em class="jxr_javadoccomment">/**</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     *     @uml.property  name="retryCommand"</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     */</em>
<a name="93" href="#93">93</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> retryCommand = false;
<a name="94" href="#94">94</a>  
<a name="95" href="#95">95</a>      <em class="jxr_javadoccomment">/**</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     *     @uml.property  name="in"</em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     */</em>
<a name="98" href="#98">98</a>      <strong class="jxr_keyword">private</strong> InputStream inputStream;    <em class="jxr_comment">// Reads responses from VCR</em>
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em class="jxr_javadoccomment">/**</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     *     For storage of the mostRecently submitted command to the VCR. When a reply is returned by the vcr this command is updated in the vcrReplyBuffer</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     *     @uml.property  name="mostRecentCommand" multiplicity="(0 -1)" dimension="1"</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     */</em>
<a name="104" href="#104">104</a>     <strong class="jxr_keyword">private</strong> byte[] mostRecentCommand;
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <em class="jxr_javadoccomment">/**</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">     *     Need to hang on to the check sum. the VCRReply object needs this.</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     *     @uml.property  name="out"</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     */</em>
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>     <em class="jxr_comment">//private byte[] mostRecentCommandChecksum;</em>
<a name="112" href="#112">112</a>     <strong class="jxr_keyword">private</strong> OutputStream outputStream;    <em class="jxr_comment">// Sends commands to VCR</em>
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a>     <em class="jxr_javadoccomment">/**</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     *     @uml.property  name="portId"</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     *     @uml.associationEnd  multiplicity="(1 1)"</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     */</em>
<a name="118" href="#118">118</a>     <strong class="jxr_keyword">private</strong> CommPortIdentifier portId;    <em class="jxr_comment">// Java port Identifier</em>
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a>     <em class="jxr_javadoccomment">/**</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     *     @uml.property  name="serialPort"</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     *     @uml.associationEnd  multiplicity="(1 1)"</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     */</em>
<a name="124" href="#124">124</a>     <strong class="jxr_keyword">private</strong> SerialPort serialPort;    <em class="jxr_comment">// Serial port connected to VCR</em>
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <em class="jxr_javadoccomment">/**</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     * @param portName</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * @throws BadPortException</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * @throws IOException</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     */</em>
<a name="131" href="#131">131</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/rs422/VCR.html">VCR</a>(String portName) <strong class="jxr_keyword">throws</strong> BadPortException, IOException {
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>         <em class="jxr_comment">// Initialize RS422 specific support classes</em>
<a name="134" href="#134">134</a>         vcrReply = <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/rs422/VCRReply.html">VCRReply</a>();
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>         <em class="jxr_comment">// Open I/O streams to the serial port</em>
<a name="137" href="#137">137</a>         <strong class="jxr_keyword">try</strong> {
<a name="138" href="#138">138</a>             serialPort = openSerialPort(portName);
<a name="139" href="#139">139</a>             inputStream = serialPort.getInputStream();
<a name="140" href="#140">140</a>             outputStream = serialPort.getOutputStream();
<a name="141" href="#141">141</a>         }
<a name="142" href="#142">142</a>         <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a name="143" href="#143">143</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/comm/BadPortException.html">BadPortException</a>(<span class="jxr_string">"Failed to open "</span> + portName, ex);
<a name="144" href="#144">144</a>         }
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a>         <em class="jxr_comment">// Request status and time code right away</em>
<a name="147" href="#147">147</a>         requestTimeCode();
<a name="148" href="#148">148</a>         requestStatus();
<a name="149" href="#149">149</a>     }
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Disconnect serial port communications */</em>
<a name="152" href="#152">152</a>     @Override
<a name="153" href="#153">153</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> disconnect() {
<a name="154" href="#154">154</a>         <strong class="jxr_keyword">try</strong> {
<a name="155" href="#155">155</a>             log.info(<span class="jxr_string">"Closing serial port:"</span> + serialPort.getName());
<a name="156" href="#156">156</a>             outputStream.close();
<a name="157" href="#157">157</a>             inputStream.close();
<a name="158" href="#158">158</a>             serialPort.close();
<a name="159" href="#159">159</a>             getVcrTimecode().getTimecode().setTime(0, 0, 0, 0);
<a name="160" href="#160">160</a>             ((<a href="../../../../org/mbari/vcr/rs422/VCRState.html">VCRState</a>) getVcrReply().getVcrState()).setStatus(0);
<a name="161" href="#161">161</a>         }
<a name="162" href="#162">162</a>         <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="163" href="#163">163</a>             <strong class="jxr_keyword">if</strong> (log.isErrorEnabled() &amp;&amp; (serialPort != <strong class="jxr_keyword">null</strong>)) {
<a name="164" href="#164">164</a>                 log.error(<span class="jxr_string">"Problem occured when closing serial port communications on "</span> + serialPort.getName());
<a name="165" href="#165">165</a>             }
<a name="166" href="#166">166</a>         }
<a name="167" href="#167">167</a> 
<a name="168" href="#168">168</a>         <strong class="jxr_keyword">super</strong>.disconnect();
<a name="169" href="#169">169</a>     }
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Eject a tape, updates status. */</em>
<a name="172" href="#172">172</a>     @Override
<a name="173" href="#173">173</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> eject() {
<a name="174" href="#174">174</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.EJECT_TAPE;
<a name="175" href="#175">175</a>         byte[] bytes = command.getBytes();
<a name="176" href="#176">176</a> 
<a name="177" href="#177">177</a>         log(command, bytes);
<a name="178" href="#178">178</a>         sendCommand(bytes);
<a name="179" href="#179">179</a>         requestStatus();
<a name="180" href="#180">180</a>     }
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Fast forward the tape, updates status. */</em>
<a name="183" href="#183">183</a>     @Override
<a name="184" href="#184">184</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fastForward() {
<a name="185" href="#185">185</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.FAST_FWD;
<a name="186" href="#186">186</a>         byte[] bytes = command.getBytes();
<a name="187" href="#187">187</a> 
<a name="188" href="#188">188</a>         log(command, bytes);
<a name="189" href="#189">189</a>         sendCommand(bytes);
<a name="190" href="#190">190</a>         requestStatus();
<a name="191" href="#191">191</a>     }
<a name="192" href="#192">192</a> 
<a name="193" href="#193">193</a>     <em class="jxr_javadoccomment">/**</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * Returns a name for this connection</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     *</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     */</em>
<a name="198" href="#198">198</a>     @Override
<a name="199" href="#199">199</a>     <strong class="jxr_keyword">public</strong> String getConnectionName() {
<a name="200" href="#200">200</a>         <strong class="jxr_keyword">return</strong> (serialPort == <strong class="jxr_keyword">null</strong>) ? <span class="jxr_string">"Not Connected"</span> : serialPort.getName();
<a name="201" href="#201">201</a>     }
<a name="202" href="#202">202</a> 
<a name="203" href="#203">203</a>     <em class="jxr_javadoccomment">/**</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     *     @return  The serial port that the VCR is using to communicate with the VCR</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     *     @uml.property  name="portId"</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     */</em>
<a name="207" href="#207">207</a>     <strong class="jxr_keyword">public</strong> CommPortIdentifier getPortId() {
<a name="208" href="#208">208</a>         <strong class="jxr_keyword">return</strong> portId;
<a name="209" href="#209">209</a>     }
<a name="210" href="#210">210</a> 
<a name="211" href="#211">211</a>     <em class="jxr_javadoccomment">/**</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment">     *  Method used to iterate through the communication ports looking for the serial port with the VCR attached to it.</em>
<a name="213" href="#213">213</a> <em class="jxr_javadoccomment">     * @return The port with the Sony VCR hooked up to it. If no VCR is found &lt;b&gt;null&lt;b/&gt; is returned</em>
<a name="214" href="#214">214</a> <em class="jxr_javadoccomment">     */</em>
<a name="215" href="#215">215</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> CommPortIdentifier getVcrPort() {
<a name="216" href="#216">216</a> 
<a name="217" href="#217">217</a>         <em class="jxr_comment">// Get a set of ports that are not in use</em>
<a name="218" href="#218">218</a>         <strong class="jxr_keyword">final</strong> HashSet serialPorts = CommUtil.getAvailableSerialPorts();
<a name="219" href="#219">219</a>         <strong class="jxr_keyword">final</strong> Iterator i = serialPorts.iterator();
<a name="220" href="#220">220</a>         CommPortIdentifier port = <strong class="jxr_keyword">null</strong>;
<a name="221" href="#221">221</a>         CommPortIdentifier vcrPort = <strong class="jxr_keyword">null</strong>;
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a>         <strong class="jxr_keyword">while</strong> (i.hasNext()) {
<a name="224" href="#224">224</a>             <strong class="jxr_keyword">try</strong> {
<a name="225" href="#225">225</a>                 port = (CommPortIdentifier) i.next();
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>                 <strong class="jxr_keyword">final</strong> <a href="../../../../org/mbari/vcr/IVCR.html">IVCR</a> vcr = <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/rs422/VCR.html">VCR</a>(port.getName());
<a name="228" href="#228">228</a> 
<a name="229" href="#229">229</a>                 vcr.requestStatus();
<a name="230" href="#230">230</a> 
<a name="231" href="#231">231</a>                 <strong class="jxr_keyword">final</strong> <a href="../../../../org/mbari/vcr/IVCRReply.html">IVCRReply</a> reply = vcr.getVcrReply();
<a name="232" href="#232">232</a>                 <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isStatusReply = (reply.isStatusReply() || reply.isAck() || reply.isNack() ||
<a name="233" href="#233">233</a>                                                reply.isTimecodeReply() || reply.isUserbitsReply());
<a name="234" href="#234">234</a> 
<a name="235" href="#235">235</a>                 vcr.disconnect();
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>                 <strong class="jxr_keyword">if</strong> (isStatusReply) {
<a name="238" href="#238">238</a>                     vcrPort = port;
<a name="239" href="#239">239</a> 
<a name="240" href="#240">240</a>                     <strong class="jxr_keyword">break</strong>;
<a name="241" href="#241">241</a>                 }
<a name="242" href="#242">242</a>             }
<a name="243" href="#243">243</a>             <strong class="jxr_keyword">catch</strong> (BadPortException e) {
<a name="244" href="#244">244</a>                 <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a name="245" href="#245">245</a>                     log.warn(<span class="jxr_string">"Problem with "</span> + port, e);
<a name="246" href="#246">246</a>                 }
<a name="247" href="#247">247</a>             }
<a name="248" href="#248">248</a>             <strong class="jxr_keyword">catch</strong> (IOException e) {
<a name="249" href="#249">249</a>                 <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a name="250" href="#250">250</a>                     log.warn(<span class="jxr_string">"Problem with "</span> + port, e);
<a name="251" href="#251">251</a>                 }
<a name="252" href="#252">252</a>             }
<a name="253" href="#253">253</a>         }
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a>         <strong class="jxr_keyword">return</strong> vcrPort;
<a name="256" href="#256">256</a>     }
<a name="257" href="#257">257</a> 
<a name="258" href="#258">258</a>     <em class="jxr_javadoccomment">/**</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment">     * Method description</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment">     *</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">     *</em>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment">     */</em>
<a name="264" href="#264">264</a>     @Override
<a name="265" href="#265">265</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/IVCRReply.html">IVCRReply</a> getVcrReply() {
<a name="266" href="#266">266</a>         <strong class="jxr_keyword">return</strong> vcrReply;
<a name="267" href="#267">267</a>     }
<a name="268" href="#268">268</a> 
<a name="269" href="#269">269</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> log(<a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command, byte[] data) {
<a name="270" href="#270">270</a>         <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="271" href="#271">271</a>             log.debug(<span class="jxr_string">"VCR &lt;&lt; ["</span> + NumberUtilities.toHexString(data) + <span class="jxr_string">"] "</span> + command.getDescription());
<a name="272" href="#272">272</a>         }
<a name="273" href="#273">273</a>     }
<a name="274" href="#274">274</a> 
<a name="275" href="#275">275</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> SerialPort openSerialPort(String serialPortName)
<a name="276" href="#276">276</a>             <strong class="jxr_keyword">throws</strong> NoSuchPortException, PortInUseException, UnsupportedCommOperationException {
<a name="277" href="#277">277</a>         CommPortIdentifier portId = CommPortIdentifier.getPortIdentifier(serialPortName);
<a name="278" href="#278">278</a>         SerialPort serialPort = (SerialPort) portId.open(<span class="jxr_string">"VCR"</span>, 2000);
<a name="279" href="#279">279</a> 
<a name="280" href="#280">280</a>         serialPort.setSerialPortParams(38400, SerialPort.DATABITS_8, SerialPort.STOPBITS_1, SerialPort.PARITY_ODD);
<a name="281" href="#281">281</a>         serialPort.setFlowControlMode(SerialPort.FLOWCONTROL_RTSCTS_IN);
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>         <em class="jxr_comment">// If the below is enabled you will not get any output from the VCR.</em>
<a name="284" href="#284">284</a>         <em class="jxr_comment">//        serialPort.setFlowControlMode(</em>
<a name="285" href="#285">285</a>         <em class="jxr_comment">//                SerialPort.FLOWCONTROL_RTSCTS_IN</em>
<a name="286" href="#286">286</a>         <em class="jxr_comment">//                &amp; SerialPort.FLOWCONTROL_RTSCTS_OUT);</em>
<a name="287" href="#287">287</a>         serialPort.enableReceiveTimeout((<strong class="jxr_keyword">int</strong>) RECEIVE_TIMEOUT);    <em class="jxr_comment">// Returns after waiting 190ms</em>
<a name="288" href="#288">288</a> 
<a name="289" href="#289">289</a>         <strong class="jxr_keyword">return</strong> serialPort;
<a name="290" href="#290">290</a>     }
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>     <em class="jxr_javadoccomment">/**</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">     * Pause the tape. This is not yet implemented</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">     *</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment">     */</em>
<a name="296" href="#296">296</a>     @Override
<a name="297" href="#297">297</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> pause() {
<a name="298" href="#298">298</a> 
<a name="299" href="#299">299</a>         <em class="jxr_comment">// Store the last command</em>
<a name="300" href="#300">300</a>         <em class="jxr_comment">//resumeCommand = vcrReply.getCommand();</em>
<a name="301" href="#301">301</a> 
<a name="302" href="#302">302</a>         <em class="jxr_comment">// TODO 20040203 brian: Insert pause command here</em>
<a name="303" href="#303">303</a>         requestStatus();
<a name="304" href="#304">304</a>     }
<a name="305" href="#305">305</a> 
<a name="306" href="#306">306</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Play the tape, updates status. */</em>
<a name="307" href="#307">307</a>     @Override
<a name="308" href="#308">308</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> play() {
<a name="309" href="#309">309</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.PLAY_FWD;
<a name="310" href="#310">310</a>         byte[] bytes = command.getBytes();
<a name="311" href="#311">311</a> 
<a name="312" href="#312">312</a>         log(command, bytes);
<a name="313" href="#313">313</a>         sendCommand(bytes);
<a name="314" href="#314">314</a>         requestStatus();
<a name="315" href="#315">315</a>     }
<a name="316" href="#316">316</a> 
<a name="317" href="#317">317</a>     <em class="jxr_javadoccomment">/**</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">     * Set the timecode on the VCR.</em>
<a name="319" href="#319">319</a> <em class="jxr_javadoccomment">     * @param timecode a byte array representing the time code value</em>
<a name="320" href="#320">320</a> <em class="jxr_javadoccomment">     */</em>
<a name="321" href="#321">321</a>     @Override
<a name="322" href="#322">322</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> presetTimecode(byte[] timecode) {
<a name="323" href="#323">323</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.PRESET_TIMECODE;
<a name="324" href="#324">324</a>         byte[] bytes = command.getBytes();
<a name="325" href="#325">325</a> 
<a name="326" href="#326">326</a>         System.arraycopy(timecode, 0, bytes, 2, timecode.length);
<a name="327" href="#327">327</a>         log(command, bytes);
<a name="328" href="#328">328</a>         sendCommand(bytes);
<a name="329" href="#329">329</a>         requestStatus();
<a name="330" href="#330">330</a>     }
<a name="331" href="#331">331</a> 
<a name="332" href="#332">332</a>     <em class="jxr_javadoccomment">/**</em>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">     * Set the Userbits on the VCR</em>
<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">     *</em>
<a name="335" href="#335">335</a> <em class="jxr_javadoccomment">     * @param userbits</em>
<a name="336" href="#336">336</a> <em class="jxr_javadoccomment">     */</em>
<a name="337" href="#337">337</a>     @Override
<a name="338" href="#338">338</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> presetUserbits(byte[] userbits) {
<a name="339" href="#339">339</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.PRESET_USERBITS;
<a name="340" href="#340">340</a>         byte[] bytes = command.getBytes();
<a name="341" href="#341">341</a> 
<a name="342" href="#342">342</a>         System.arraycopy(userbits, 0, bytes, 2, userbits.length);
<a name="343" href="#343">343</a>         log(command, bytes);
<a name="344" href="#344">344</a>         sendCommand(bytes);
<a name="345" href="#345">345</a>         requestStatus();
<a name="346" href="#346">346</a>     }
<a name="347" href="#347">347</a> 
<a name="348" href="#348">348</a>     <em class="jxr_javadoccomment">/**</em>
<a name="349" href="#349">349</a> <em class="jxr_javadoccomment">     * Reads the response to a command from the serial port connected to the VCR.</em>
<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">     * @throws IOException</em>
<a name="351" href="#351">351</a> <em class="jxr_javadoccomment">     * @throws VCRException</em>
<a name="352" href="#352">352</a> <em class="jxr_javadoccomment">     * @throws InterruptedException</em>
<a name="353" href="#353">353</a> <em class="jxr_javadoccomment">     */</em>
<a name="354" href="#354">354</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> readResponse() <strong class="jxr_keyword">throws</strong> IOException, VCRException, InterruptedException {
<a name="355" href="#355">355</a> 
<a name="356" href="#356">356</a>         <em class="jxr_comment">// Get the command returned by the VCR</em>
<a name="357" href="#357">357</a>         <strong class="jxr_keyword">final</strong> byte[] cmd = <strong class="jxr_keyword">new</strong> byte[2];
<a name="358" href="#358">358</a> 
<a name="359" href="#359">359</a>         <strong class="jxr_keyword">if</strong> (inputStream.available() &gt; 0) {
<a name="360" href="#360">360</a>             inputStream.read(cmd);
<a name="361" href="#361">361</a>         }
<a name="362" href="#362">362</a> 
<a name="363" href="#363">363</a>         Thread.sleep(IO_DELAY);    <em class="jxr_comment">// RXTX does not block serial IO correctly.</em>
<a name="364" href="#364">364</a> 
<a name="365" href="#365">365</a>         <em class="jxr_comment">// Extract the number of data bytes in the command block. Then</em>
<a name="366" href="#366">366</a>         <em class="jxr_comment">// read the data from the serial port</em>
<a name="367" href="#367">367</a>         <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> numDataBytes = (<strong class="jxr_keyword">int</strong>) (cmd[0] &amp; 0x0F);    <em class="jxr_comment">// Get the number of data blocks</em>
<a name="368" href="#368">368</a>         byte[] data = <strong class="jxr_keyword">null</strong>;
<a name="369" href="#369">369</a> 
<a name="370" href="#370">370</a>         <strong class="jxr_keyword">if</strong> (numDataBytes &gt; 0) {
<a name="371" href="#371">371</a>             data = <strong class="jxr_keyword">new</strong> byte[numDataBytes];
<a name="372" href="#372">372</a> 
<a name="373" href="#373">373</a>             <strong class="jxr_keyword">if</strong> (inputStream.available() &gt; 0) {
<a name="374" href="#374">374</a>                 inputStream.read(data);
<a name="375" href="#375">375</a>             }
<a name="376" href="#376">376</a>             <strong class="jxr_keyword">else</strong> {
<a name="377" href="#377">377</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Incoming data is missing . byte[] = "</span> + NumberUtilities.toHexString(cmd));
<a name="378" href="#378">378</a>             }
<a name="379" href="#379">379</a>         }
<a name="380" href="#380">380</a> 
<a name="381" href="#381">381</a>         Thread.sleep(IO_DELAY);    <em class="jxr_comment">// RXTX does not block serial IO correctly.</em>
<a name="382" href="#382">382</a> 
<a name="383" href="#383">383</a>         <em class="jxr_comment">// Read the checksum that the VCR sends</em>
<a name="384" href="#384">384</a>         <strong class="jxr_keyword">final</strong> byte[] checksum = <strong class="jxr_keyword">new</strong> byte[1];
<a name="385" href="#385">385</a> 
<a name="386" href="#386">386</a>         <strong class="jxr_keyword">if</strong> (inputStream.available() &gt; 0) {
<a name="387" href="#387">387</a>             inputStream.read(checksum);
<a name="388" href="#388">388</a>         }
<a name="389" href="#389">389</a>         <strong class="jxr_keyword">else</strong> {
<a name="390" href="#390">390</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Incoming checksum is missing. cmd[] =  "</span> + NumberUtilities.toHexString(cmd) +
<a name="391" href="#391">391</a>                                   <span class="jxr_string">" data[] = "</span> + NumberUtilities.toHexString(data));
<a name="392" href="#392">392</a>         }
<a name="393" href="#393">393</a> 
<a name="394" href="#394">394</a>         <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="395" href="#395">395</a> 
<a name="396" href="#396">396</a>             <em class="jxr_comment">/*</em>
<a name="397" href="#397">397</a> <em class="jxr_comment">             * Munge it all into a single byte array</em>
<a name="398" href="#398">398</a> <em class="jxr_comment">             */</em>
<a name="399" href="#399">399</a>             <strong class="jxr_keyword">int</strong> dataLength = (data == <strong class="jxr_keyword">null</strong>) ? 0 : data.length;
<a name="400" href="#400">400</a>             <strong class="jxr_keyword">final</strong> byte[] c = <strong class="jxr_keyword">new</strong> byte[cmd.length + dataLength + 1];
<a name="401" href="#401">401</a> 
<a name="402" href="#402">402</a>             System.arraycopy(cmd, 0, c, 0, cmd.length);
<a name="403" href="#403">403</a> 
<a name="404" href="#404">404</a>             <strong class="jxr_keyword">if</strong> (data != <strong class="jxr_keyword">null</strong>) {
<a name="405" href="#405">405</a>                 System.arraycopy(data, 0, c, cmd.length, data.length);
<a name="406" href="#406">406</a>             }
<a name="407" href="#407">407</a> 
<a name="408" href="#408">408</a>             c[c.length - 1] = checksum[0];
<a name="409" href="#409">409</a> 
<a name="410" href="#410">410</a>             log.debug(<span class="jxr_string">"VCR &gt;&gt; ["</span> + NumberUtilities.toHexString(c) + <span class="jxr_string">"]"</span>);
<a name="411" href="#411">411</a>         }
<a name="412" href="#412">412</a> 
<a name="413" href="#413">413</a>         ((org.mbari.vcr.rs422.VCRReply) vcrReply).update(mostRecentCommand, cmd, data, checksum);
<a name="414" href="#414">414</a> 
<a name="415" href="#415">415</a> 
<a name="416" href="#416">416</a>     }
<a name="417" href="#417">417</a> 
<a name="418" href="#418">418</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Start recording, updates status. */</em>
<a name="419" href="#419">419</a>     @Override
<a name="420" href="#420">420</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> record() {
<a name="421" href="#421">421</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.RECORD;
<a name="422" href="#422">422</a>         byte[] bytes = command.getBytes();
<a name="423" href="#423">423</a> 
<a name="424" href="#424">424</a>         log(command, bytes);
<a name="425" href="#425">425</a>         sendCommand(bytes);
<a name="426" href="#426">426</a>         requestStatus();
<a name="427" href="#427">427</a>     }
<a name="428" href="#428">428</a> 
<a name="429" href="#429">429</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Release the tape, updates status. */</em>
<a name="430" href="#430">430</a>     @Override
<a name="431" href="#431">431</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> releaseTape() {
<a name="432" href="#432">432</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.RELEASE_TAPE;
<a name="433" href="#433">433</a>         byte[] bytes = command.getBytes();
<a name="434" href="#434">434</a> 
<a name="435" href="#435">435</a>         log(command, bytes);
<a name="436" href="#436">436</a>         sendCommand(bytes);
<a name="437" href="#437">437</a>         requestStatus();
<a name="438" href="#438">438</a>     }
<a name="439" href="#439">439</a> 
<a name="440" href="#440">440</a>     <em class="jxr_javadoccomment">/**</em>
<a name="441" href="#441">441</a> <em class="jxr_javadoccomment">     * Query the VCR for its type. Return codes are MODEL        Data-1      Data-2&lt;br&gt; BVH-2000(00) 00  11&lt;br&gt;</em>
<a name="442" href="#442">442</a> <em class="jxr_javadoccomment">     * BVH-2000(02) 00  10&lt;br&gt;</em>
<a name="443" href="#443">443</a> <em class="jxr_javadoccomment">     */</em>
<a name="444" href="#444">444</a>     @Override
<a name="445" href="#445">445</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestDeviceType() {
<a name="446" href="#446">446</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.DEVICE_TYPE_REQUEST;
<a name="447" href="#447">447</a>         byte[] bytes = command.getBytes();
<a name="448" href="#448">448</a> 
<a name="449" href="#449">449</a>         log(command, bytes);
<a name="450" href="#450">450</a>         sendCommand(bytes);
<a name="451" href="#451">451</a>     }
<a name="452" href="#452">452</a> 
<a name="453" href="#453">453</a>     <em class="jxr_javadoccomment">/**</em>
<a name="454" href="#454">454</a> <em class="jxr_javadoccomment">     * Get longitudial timecode, which is stored on the audio track. Not as</em>
<a name="455" href="#455">455</a> <em class="jxr_javadoccomment">     * accurate as getVTimeCode, but this method will get timecodes during fast-forwards, rewinds and shuttiling</em>
<a name="456" href="#456">456</a> <em class="jxr_javadoccomment">     */</em>
<a name="457" href="#457">457</a>     @Override
<a name="458" href="#458">458</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestLTimeCode() {
<a name="459" href="#459">459</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.GET_LTIMECODE;
<a name="460" href="#460">460</a>         byte[] bytes = command.getBytes();
<a name="461" href="#461">461</a> 
<a name="462" href="#462">462</a>         log(command, bytes);
<a name="463" href="#463">463</a>         sendCommand(bytes);
<a name="464" href="#464">464</a>     }
<a name="465" href="#465">465</a> 
<a name="466" href="#466">466</a>     <em class="jxr_javadoccomment">/**</em>
<a name="467" href="#467">467</a> <em class="jxr_javadoccomment">     * &lt;p&gt;&lt;!-- Method description --&gt;&lt;/p&gt;</em>
<a name="468" href="#468">468</a> <em class="jxr_javadoccomment">     *</em>
<a name="469" href="#469">469</a> <em class="jxr_javadoccomment">     */</em>
<a name="470" href="#470">470</a>     @Override
<a name="471" href="#471">471</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestLUserbits() {
<a name="472" href="#472">472</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.GET_LUBTIMECODE;
<a name="473" href="#473">473</a>         byte[] bytes = command.getBytes();
<a name="474" href="#474">474</a> 
<a name="475" href="#475">475</a>         log(command, bytes);
<a name="476" href="#476">476</a>         sendCommand(bytes);
<a name="477" href="#477">477</a>     }
<a name="478" href="#478">478</a> 
<a name="479" href="#479">479</a>     <em class="jxr_javadoccomment">/**</em>
<a name="480" href="#480">480</a> <em class="jxr_javadoccomment">     * &lt;p&gt;&lt;!-- Method description --&gt;&lt;/p&gt;</em>
<a name="481" href="#481">481</a> <em class="jxr_javadoccomment">     *</em>
<a name="482" href="#482">482</a> <em class="jxr_javadoccomment">     */</em>
<a name="483" href="#483">483</a>     @Override
<a name="484" href="#484">484</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestLocalDisable() {
<a name="485" href="#485">485</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.LOCAL_DISABLE;
<a name="486" href="#486">486</a>         byte[] bytes = command.getBytes();
<a name="487" href="#487">487</a> 
<a name="488" href="#488">488</a>         log(command, bytes);
<a name="489" href="#489">489</a>         sendCommand(bytes);
<a name="490" href="#490">490</a>     }
<a name="491" href="#491">491</a> 
<a name="492" href="#492">492</a>     <em class="jxr_javadoccomment">/**</em>
<a name="493" href="#493">493</a> <em class="jxr_javadoccomment">     * &lt;p&gt;&lt;!-- Method description --&gt;&lt;/p&gt;</em>
<a name="494" href="#494">494</a> <em class="jxr_javadoccomment">     *</em>
<a name="495" href="#495">495</a> <em class="jxr_javadoccomment">     */</em>
<a name="496" href="#496">496</a>     @Override
<a name="497" href="#497">497</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestLocalEnable() {
<a name="498" href="#498">498</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.LOCAL_ENABLE;
<a name="499" href="#499">499</a>         byte[] bytes = command.getBytes();
<a name="500" href="#500">500</a> 
<a name="501" href="#501">501</a>         log(command, bytes);
<a name="502" href="#502">502</a>         sendCommand(bytes);
<a name="503" href="#503">503</a>     }
<a name="504" href="#504">504</a> 
<a name="505" href="#505">505</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Send a "get status" command to the <a href="../../../../org/mbari/vcr/rs422/VCR.html">VCR</a> */</em>
<a name="506" href="#506">506</a>     @Override
<a name="507" href="#507">507</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestStatus() {
<a name="508" href="#508">508</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.GET_STATUS;
<a name="509" href="#509">509</a>         byte[] bytes = command.getBytes();
<a name="510" href="#510">510</a> 
<a name="511" href="#511">511</a>         log(command, bytes);
<a name="512" href="#512">512</a>         sendCommand(bytes);
<a name="513" href="#513">513</a>     }
<a name="514" href="#514">514</a> 
<a name="515" href="#515">515</a>     <em class="jxr_javadoccomment">/**</em>
<a name="516" href="#516">516</a> <em class="jxr_javadoccomment">     * When requesting a timecode, the results depend on the tape speed because</em>
<a name="517" href="#517">517</a> <em class="jxr_javadoccomment">     * at very low speeds (&gt; 0.25 play speed) it may not be possible to recover</em>
<a name="518" href="#518">518</a> <em class="jxr_javadoccomment">     * the timecode. However, if VITC is present it may be used instead. To</em>
<a name="519" href="#519">519</a> <em class="jxr_javadoccomment">     * automate the decision process, Sony has provided a special command which</em>
<a name="520" href="#520">520</a> <em class="jxr_javadoccomment">     * will return the best source of timecode. Note that when LTC and VITC are</em>
<a name="521" href="#521">521</a> <em class="jxr_javadoccomment">     * both garbage you get back the 74.14 corrected LTC data. In this case, the</em>
<a name="522" href="#522">522</a> <em class="jxr_javadoccomment">     * time is actually the last good LTC time corrected by the tape timer.</em>
<a name="523" href="#523">523</a> <em class="jxr_javadoccomment">     *</em>
<a name="524" href="#524">524</a> <em class="jxr_javadoccomment">     */</em>
<a name="525" href="#525">525</a>     @Override
<a name="526" href="#526">526</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestTimeCode() {
<a name="527" href="#527">527</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.GET_TIMECODE;
<a name="528" href="#528">528</a>         byte[] bytes = command.getBytes();
<a name="529" href="#529">529</a> 
<a name="530" href="#530">530</a>         log(command, bytes);
<a name="531" href="#531">531</a>         sendCommand(bytes);
<a name="532" href="#532">532</a>     }
<a name="533" href="#533">533</a> 
<a name="534" href="#534">534</a>     <em class="jxr_javadoccomment">/**</em>
<a name="535" href="#535">535</a> <em class="jxr_javadoccomment">     * Tries to request the best userbits. This method has not been tested.</em>
<a name="536" href="#536">536</a> <em class="jxr_javadoccomment">     *</em>
<a name="537" href="#537">537</a> <em class="jxr_javadoccomment">     */</em>
<a name="538" href="#538">538</a>     @Override
<a name="539" href="#539">539</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestUserbits() {
<a name="540" href="#540">540</a>         <strong class="jxr_keyword">if</strong> (getVcrState().isPlaying()) {
<a name="541" href="#541">541</a>             requestVUserbits();
<a name="542" href="#542">542</a>         }
<a name="543" href="#543">543</a>         <strong class="jxr_keyword">else</strong> {
<a name="544" href="#544">544</a>             requestLUserbits();
<a name="545" href="#545">545</a>         }
<a name="546" href="#546">546</a>     }
<a name="547" href="#547">547</a> 
<a name="548" href="#548">548</a>     <em class="jxr_javadoccomment">/**</em>
<a name="549" href="#549">549</a> <em class="jxr_javadoccomment">     * Get vertical timecode, which is stored between video frames. These</em>
<a name="550" href="#550">550</a> <em class="jxr_javadoccomment">     * timecodes can not be accessed in any mode accept play mode. So use</em>
<a name="551" href="#551">551</a> <em class="jxr_javadoccomment">     * getLTimeCode when fast-forwarding, rewinding, or shuttling</em>
<a name="552" href="#552">552</a> <em class="jxr_javadoccomment">     */</em>
<a name="553" href="#553">553</a>     @Override
<a name="554" href="#554">554</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestVTimeCode() {
<a name="555" href="#555">555</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.GET_VTIMECODE;
<a name="556" href="#556">556</a>         byte[] bytes = command.getBytes();
<a name="557" href="#557">557</a> 
<a name="558" href="#558">558</a>         log(command, bytes);
<a name="559" href="#559">559</a>         sendCommand(bytes);
<a name="560" href="#560">560</a>     }
<a name="561" href="#561">561</a> 
<a name="562" href="#562">562</a>     <em class="jxr_javadoccomment">/**</em>
<a name="563" href="#563">563</a> <em class="jxr_javadoccomment">     * &lt;p&gt;&lt;!-- Method description --&gt;&lt;/p&gt;</em>
<a name="564" href="#564">564</a> <em class="jxr_javadoccomment">     *</em>
<a name="565" href="#565">565</a> <em class="jxr_javadoccomment">     */</em>
<a name="566" href="#566">566</a>     @Override
<a name="567" href="#567">567</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> requestVUserbits() {
<a name="568" href="#568">568</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.GET_VUBTIMECODE;
<a name="569" href="#569">569</a>         byte[] bytes = command.getBytes();
<a name="570" href="#570">570</a> 
<a name="571" href="#571">571</a>         log(command, bytes);
<a name="572" href="#572">572</a>         sendCommand(bytes);
<a name="573" href="#573">573</a>     }
<a name="574" href="#574">574</a> 
<a name="575" href="#575">575</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Resumes the last command that was paused. This is not yet implemented */</em>
<a name="576" href="#576">576</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> resume() {
<a name="577" href="#577">577</a> 
<a name="578" href="#578">578</a>         <em class="jxr_comment">//      No implementation</em>
<a name="579" href="#579">579</a>     }
<a name="580" href="#580">580</a> 
<a name="581" href="#581">581</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Rewind the tape, updates status. */</em>
<a name="582" href="#582">582</a>     @Override
<a name="583" href="#583">583</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> rewind() {
<a name="584" href="#584">584</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.REWIND;
<a name="585" href="#585">585</a>         byte[] bytes = command.getBytes();
<a name="586" href="#586">586</a> 
<a name="587" href="#587">587</a>         log(command, bytes);
<a name="588" href="#588">588</a>         sendCommand(bytes);
<a name="589" href="#589">589</a>         requestStatus();
<a name="590" href="#590">590</a>     }
<a name="591" href="#591">591</a> 
<a name="592" href="#592">592</a>     <em class="jxr_javadoccomment">/**</em>
<a name="593" href="#593">593</a> <em class="jxr_javadoccomment">     * Fast forward to the specified timecode, updates status.</em>
<a name="594" href="#594">594</a> <em class="jxr_javadoccomment">     * @param timecode a byte array representing the time code value</em>
<a name="595" href="#595">595</a> <em class="jxr_javadoccomment">     * @see VCRUtil</em>
<a name="596" href="#596">596</a> <em class="jxr_javadoccomment">     */</em>
<a name="597" href="#597">597</a>     @Override
<a name="598" href="#598">598</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> seekTimecode(byte[] timecode) {
<a name="599" href="#599">599</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.SONY_SEEK_TIMECODE;
<a name="600" href="#600">600</a>         byte[] bytes = command.getBytes();
<a name="601" href="#601">601</a> 
<a name="602" href="#602">602</a>         System.arraycopy(timecode, 0, bytes, 2, timecode.length);
<a name="603" href="#603">603</a>         log(command, bytes);
<a name="604" href="#604">604</a>         sendCommand(bytes);
<a name="605" href="#605">605</a>         requestStatus();
<a name="606" href="#606">606</a>     }
<a name="607" href="#607">607</a> 
<a name="608" href="#608">608</a>     <em class="jxr_javadoccomment">/**</em>
<a name="609" href="#609">609</a> <em class="jxr_javadoccomment">     * Fast forward to the specified timecode, updates status.</em>
<a name="610" href="#610">610</a> <em class="jxr_javadoccomment">     * @param timecode</em>
<a name="611" href="#611">611</a> <em class="jxr_javadoccomment">     */</em>
<a name="612" href="#612">612</a>     @Override
<a name="613" href="#613">613</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> seekTimecode(<strong class="jxr_keyword">int</strong> timecode) {
<a name="614" href="#614">614</a>         seekTimecode(NumberUtilities.toByteArray(timecode));
<a name="615" href="#615">615</a>     }
<a name="616" href="#616">616</a> 
<a name="617" href="#617">617</a>     @Override
<a name="618" href="#618">618</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> seekTimecode(Timecode timecode) {
<a name="619" href="#619">619</a>         byte[] time = <strong class="jxr_keyword">new</strong> byte[] { VCRUtil.intToTime(timecode.getFrame()), VCRUtil.intToTime(timecode.getSecond()),
<a name="620" href="#620">620</a>                                    VCRUtil.intToTime(timecode.getMinute()), VCRUtil.intToTime(timecode.getHour()) };
<a name="621" href="#621">621</a> 
<a name="622" href="#622">622</a>         seekTimecode(time);
<a name="623" href="#623">623</a>     }
<a name="624" href="#624">624</a> 
<a name="625" href="#625">625</a>     <em class="jxr_javadoccomment">/**</em>
<a name="626" href="#626">626</a> <em class="jxr_javadoccomment">     * Sends a command, in the format of a byte[], to the VCR.</em>
<a name="627" href="#627">627</a> <em class="jxr_javadoccomment">     * @param command The command to send to the VCR</em>
<a name="628" href="#628">628</a> <em class="jxr_javadoccomment">     */</em>
<a name="629" href="#629">629</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> sendCommand(byte[] command) {
<a name="630" href="#630">630</a> 
<a name="631" href="#631">631</a>         <em class="jxr_comment">// Store the last command</em>
<a name="632" href="#632">632</a>         <strong class="jxr_keyword">this</strong>.mostRecentCommand = command;
<a name="633" href="#633">633</a> 
<a name="634" href="#634">634</a>         <em class="jxr_comment">// Add the checksum</em>
<a name="635" href="#635">635</a>         byte checksum = VCRReply.calculateChecksum(command);
<a name="636" href="#636">636</a> 
<a name="637" href="#637">637</a>         command[command.length - 1] = checksum;
<a name="638" href="#638">638</a> 
<a name="639" href="#639">639</a>         <strong class="jxr_keyword">try</strong> {
<a name="640" href="#640">640</a> 
<a name="641" href="#641">641</a>             outputStream.write(command);
<a name="642" href="#642">642</a>             Thread.sleep(IO_DELAY);    <em class="jxr_comment">// RXTX does not block serial IO correctly.</em>
<a name="643" href="#643">643</a>             readResponse();
<a name="644" href="#644">644</a> 
<a name="645" href="#645">645</a>         }
<a name="646" href="#646">646</a>         <strong class="jxr_keyword">catch</strong> (IOException e) {
<a name="647" href="#647">647</a>             log.error(<span class="jxr_string">"Failed to send a command to the VCR"</span>, e);
<a name="648" href="#648">648</a>         }
<a name="649" href="#649">649</a>         <strong class="jxr_keyword">catch</strong> (VCRException e) {
<a name="650" href="#650">650</a>             log.error(<span class="jxr_string">"Failed to send a command to the VCR"</span>, e);
<a name="651" href="#651">651</a>         }
<a name="652" href="#652">652</a>         <strong class="jxr_keyword">catch</strong> (InterruptedException e) {
<a name="653" href="#653">653</a>             log.error(<span class="jxr_string">"Thread "</span> + Thread.currentThread().getName() + <span class="jxr_string">" was interrupted"</span>, e);
<a name="654" href="#654">654</a>             Thread.currentThread().interrupt();
<a name="655" href="#655">655</a>         }
<a name="656" href="#656">656</a>     }
<a name="657" href="#657">657</a> 
<a name="658" href="#658">658</a>     <em class="jxr_javadoccomment">/**</em>
<a name="659" href="#659">659</a> <em class="jxr_javadoccomment">     * shuttle foward using the giving speed, updates status.</em>
<a name="660" href="#660">660</a> <em class="jxr_javadoccomment">     * @param speed value between 0 (slow) and 255 (fast)</em>
<a name="661" href="#661">661</a> <em class="jxr_javadoccomment">     */</em>
<a name="662" href="#662">662</a>     @Override
<a name="663" href="#663">663</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> shuttleForward(<strong class="jxr_keyword">int</strong> speed) {
<a name="664" href="#664">664</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.SHUTTLE_FWD;
<a name="665" href="#665">665</a>         byte[] bytes = command.getBytes();
<a name="666" href="#666">666</a> 
<a name="667" href="#667">667</a>         <em class="jxr_comment">// put the correct speed in the byte array</em>
<a name="668" href="#668">668</a>         byte[] byteSpeed = NumberUtilities.toByteArray(speed);
<a name="669" href="#669">669</a> 
<a name="670" href="#670">670</a>         bytes[2] = byteSpeed[3];    <em class="jxr_comment">// speed is between 0-255, ignore other bytes</em>
<a name="671" href="#671">671</a>         log(command, bytes);
<a name="672" href="#672">672</a>         sendCommand(bytes);
<a name="673" href="#673">673</a>         requestStatus();
<a name="674" href="#674">674</a>     }
<a name="675" href="#675">675</a> 
<a name="676" href="#676">676</a>     <em class="jxr_javadoccomment">/**</em>
<a name="677" href="#677">677</a> <em class="jxr_javadoccomment">     * shuttle backwards using the giving speed, updates status.</em>
<a name="678" href="#678">678</a> <em class="jxr_javadoccomment">     * @param speed value between 0 (slow) and 255 (fast)</em>
<a name="679" href="#679">679</a> <em class="jxr_javadoccomment">     */</em>
<a name="680" href="#680">680</a>     @Override
<a name="681" href="#681">681</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> shuttleReverse(<strong class="jxr_keyword">int</strong> speed) {
<a name="682" href="#682">682</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.SHUTTLE_REV;
<a name="683" href="#683">683</a>         byte[] bytes = command.getBytes();
<a name="684" href="#684">684</a> 
<a name="685" href="#685">685</a>         <em class="jxr_comment">// put the correct speed in the byte array</em>
<a name="686" href="#686">686</a>         byte[] byteSpeed = NumberUtilities.toByteArray(speed);
<a name="687" href="#687">687</a> 
<a name="688" href="#688">688</a>         bytes[2] = byteSpeed[3];    <em class="jxr_comment">// speed is between 0-255, ignore other bytes</em>
<a name="689" href="#689">689</a>         log(command, bytes);
<a name="690" href="#690">690</a>         sendCommand(bytes);
<a name="691" href="#691">691</a>         requestStatus();
<a name="692" href="#692">692</a>     }
<a name="693" href="#693">693</a> 
<a name="694" href="#694">694</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stop the tape, updates status. */</em>
<a name="695" href="#695">695</a>     @Override
<a name="696" href="#696">696</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> stop() {
<a name="697" href="#697">697</a>         <a href="../../../../org/mbari/vcr/rs422/Command.html">Command</a> command = Command.STOP;
<a name="698" href="#698">698</a>         byte[] bytes = command.getBytes();
<a name="699" href="#699">699</a> 
<a name="700" href="#700">700</a>         log(command, bytes);
<a name="701" href="#701">701</a>         sendCommand(bytes);
<a name="702" href="#702">702</a>         requestStatus();
<a name="703" href="#703">703</a>     }
<a name="704" href="#704">704</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

